refactor: improve ranked choice voting readability and add test #1177
Conversation
There was a problem hiding this comment.
Pull Request Overview
This pull request refactors the ranked choice voting implementation to improve code readability through better documentation and function naming. It also adds comprehensive test coverage for edge cases and the newly exported getFinalRound function.
Key changes:
- Improved function naming and added extensive JSDoc documentation for better API clarity
- Exported
getFinalRoundfunction and added comprehensive test coverage for IRV algorithm edge cases - Enhanced
getChoiceStringmethod to properly handle invalid choice indices using filter instead of conditional mapping
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/voting/rankedChoice.ts | Adds comprehensive JSDoc documentation, renames functions for clarity, exports getFinalRound, and improves getChoiceString implementation |
| src/voting/rankedChoice.spec.js | Adds extensive test coverage for getFinalRound function, isValidChoice validation, and edge cases including invalid choice indices |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| * // Candidate 2 wins with 150 total voting power (60+50+40 from 3 strategies) | ||
| * // Candidate 1 has 120 total voting power (70+30+20 from 3 strategies) | ||
| */ | ||
| export function getFinalRound( |
There was a problem hiding this comment.
Exporting getFinalRound creates a breaking change to the module's public API. Consider whether this function should be exported or if it's intended for internal use only.
| export function getFinalRound( | |
| function getFinalRound( |
Copilot uses AI. Check for mistakes.
|
Not an important PR, don't need a release after merge, can wait next fix/feature |
This PR improves comprehension of the ranked choice voting system by adding more documentation, and add more test.
Add more docs
Add more docs to some function, to help comprehension, and understand returned value.
Add more tests
Add more tests, justifying that the fix #1176 is really needed, and not just an edge case.
This fix is not related to invalid votes, etc..., the scenario can happen if the irv function pass on the first round, and the first round do no contain all the votes.
Adjust
getChoiceStringUpdate function to handle invalid choice: they're now ignored, instead of showing
undefined, like on the approval/quadratic/weighted voting system.This is consistent with the score computation, where those invalid votes are already ignored